Pixel-Perfect Reports

The Pixel-Perfect Reports widget enables you to embed the Pixel-Perfect Reports feature in an application.

Embeddable Sample

Important: This example is for testing purposes only.

• In production, you must use a qvToken instead of exposing an apiKey in the UI.
• The apiKey is private and should only be used for backend-to-backend communication.

<!-- Tag -->
<qrvey-pixel-builder settings="reportsConfig"></qrvey-pixel-builder>

<!-- Config -->
<script>
  var reportsConfig = {
    "apiKey": "<YOUR_PRIVATE_API_KEY>",
    "domain": "<DOMAIN>",
    "userId": "<USER_ID>",
    "appId": "<APP_ID>",
    "clientId": "<CLIENT_ID>", //Optional.
    "orgId": "org:0" // Optional. your relevant orgId

  };
</script>

<!-- Launcher -->
<script type="text/javascript" src="https://<YOUR_QRVEY_DOMAIN>/widgets-launcher/app.js"></script>

Production Deployment

• Use qvToken instead of apiKey.
• Pass sensitive values (appId, userId, clientId) securely using qvToken.
• Configure timezone, parameters, and UI options as needed for production.

Configuration Object

Property	Value	Required
qvToken	String, Encrypted token used for secure authentication.	Required, if apiKey is not provided
apiKey	String, Your organization’s unique API key required to access the Qrvey platform.	Required, if qvToken is not provided.
domain	String, The base URL of your Qrvey instance.	Required
appId	String, ID of the Qrvey application that contains the asset you want to embed.	Required
userId	String, ID of the Qrvey Composer user account accessing this feature. Optional: You can alternately specify the user ID in a Qrvey session cookie.	Required
clientid	String, Unique identifier for the tenant end user. Required for using the End User Personalization and Download Manager features. The clientid must be set to a unique value for each tenant end user.	Optional
timezone	Object, Overrides the time zone setting in Qrvey Admin Center. For more information, see timezone object.	Optional
reportId	String, Used to embed a specific report by ID. If omitted, this embeds the "browse all reports" page.	Optional
orgId	String, Organization ID for the end user. Used to pass organization context to other components.	Optional
orgs	Object Array, The orgs object to list users, defined per organization, in the Subscribe modal. Note: The orgs object is ignored when the widget's orgId is set to"org:0".	Optional
email	String, Email of the clientId user. When passed in the qvToken, enables scheduling of exports and subscriptions.	Optional
showFormulasButton	Boolean, Shows or hides the formula modal button in the toolbar. It is "visible" by default.	Optional
showBucketsButton	Boolean, Shows or hides the bucket modal button in the toolbar. It is "visible" by default.	Optional
parameterValues	Object, Enables you to set the value of a pixel perfect parameter. This value will override the default value set for the parameter. Pattern: { key1: value1, key2: value2 } Example: { parameterName: paramVal }.	Optional
defaultMode	String, either "preview" or "design". A value of "preview" enables users to embed the Pixel-Perfect Reports in preview mode. Defaults to "design" if not set.	Optional

Timezone

For more information, see Configuring Time Zone Settings.

Parameter	Description	Required
offset	string, Time to offset by. Pattern: {"HH:MM" } Example: { "offset": "-1:00" }	Optional

Customization

The customization options for the Pixel-Perfect Reports allow you to hide the export options.

const widgetConfig = {
  domain: "my-domain.qrvey.com",
  qvToken: "mySecureToken",
  ...
  customization: {
    // Global elements to remove
    remove: [
      '*.qDownloadReport', //The Download option in Preview mode.
      '*.qScheduleOption', //The schedule button inside the download modal.
      '*.qSubscribeOption', //The Subscribe tab within the Download modal.
      '*.qSubscribeExternalUsers' //The option to add external users using the Enter key within the Subscribe tab.
    ]
  }
};